<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen; http://apigen.org" />

	<title>Class Nette\Debug</title>

	<link rel="stylesheet" href="resources/style.css?v=2011071314" type="text/css" media="all" />
	<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
	<link rel="search" href="opensearch.xml" type="application/opensearchdescription+xml" title="Nette Framework API documentation" />
	<script type="text/javascript" src="resources/combined.js"></script>
	<script type="text/javascript" src="allclasses.js"></script>
</head>

<body>
<div id="left">
	<a href="allclasses.html">All Classes</a>

	<h3>Namespaces</h3>
	<ul>
		<li><a href="namespace-none.html">none</a>
		</li>
		<li class="active"><a href="namespace-Nette.html">Nette</a>
		</li>
		<li><a href="namespace-Nette.Application.html">Nette\Application</a>
		</li>
		<li><a href="namespace-Nette.Caching.html">Nette\Caching</a>
		</li>
		<li><a href="namespace-Nette.Collections.html">Nette\Collections</a>
		</li>
		<li><a href="namespace-Nette.Config.html">Nette\Config</a>
		</li>
		<li><a href="namespace-Nette.Forms.html">Nette\Forms</a>
		</li>
		<li><a href="namespace-Nette.IO.html">Nette\IO</a>
		</li>
		<li><a href="namespace-Nette.Loaders.html">Nette\Loaders</a>
		</li>
		<li><a href="namespace-Nette.Mail.html">Nette\Mail</a>
		</li>
		<li><a href="namespace-Nette.Reflection.html">Nette\Reflection</a>
		</li>
		<li><a href="namespace-Nette.Security.html">Nette\Security</a>
		</li>
		<li><a href="namespace-Nette.Templates.html">Nette\Templates</a>
		</li>
		<li><a href="namespace-Nette.Web.html">Nette\Web</a>
		</li>
		<li><a href="namespace-PHP.html">PHP</a>
		</li>
	</ul>

	<hr />

	<h3>Classes</h3>

	<ul>
		<li><a href="Nette.ArrayTools.html">ArrayTools</a></li>
		<li><a href="Nette.Callback.html">Callback</a></li>
		<li><a href="Nette.Component.html">Component</a></li>
		<li><a href="Nette.ComponentContainer.html">ComponentContainer</a></li>
		<li><a href="Nette.Configurator.html">Configurator</a></li>
		<li><a href="Nette.DateTime.html">DateTime</a></li>
		<li class="active"><a href="Nette.Debug.html">Debug</a></li>
		<li><a href="Nette.Environment.html">Environment</a></li>
		<li><a href="Nette.Framework.html">Framework</a></li>
		<li><a href="Nette.FreezableObject.html">FreezableObject</a></li>
		<li><a href="Nette.GenericRecursiveIterator.html">GenericRecursiveIterator</a></li>
		<li><a href="Nette.Image.html">Image</a></li>
		<li><a href="Nette.ImageMagick.html">ImageMagick</a></li>
		<li><a href="Nette.InstanceFilterIterator.html">InstanceFilterIterator</a></li>
		<li><a href="Nette.Object.html">Object</a></li>
		<li><a href="Nette.ObjectMixin.html">ObjectMixin</a></li>
		<li><a href="Nette.Paginator.html">Paginator</a></li>
		<li><a href="Nette.RecursiveComponentIterator.html">RecursiveComponentIterator</a></li>
		<li><a href="Nette.ServiceLocator.html">ServiceLocator</a></li>
		<li><a href="Nette.SmartCachingIterator.html">SmartCachingIterator</a></li>
		<li><a href="Nette.String.html">String</a></li>
		<li><a href="Nette.Tools.html">Tools</a></li>
	</ul>

	<h3>Interfaces</h3>

	<ul>
		<li><a href="Nette.IComponent.html">IComponent</a></li>
		<li><a href="Nette.IComponentContainer.html">IComponentContainer</a></li>
		<li><a href="Nette.IDebuggable.html">IDebuggable</a></li>
		<li><a href="Nette.IServiceLocator.html">IServiceLocator</a></li>
		<li><a href="Nette.ITranslator.html">ITranslator</a></li>
	</ul>

	<h3>Exceptions</h3>

	<ul>
		<li><a href="Nette.AmbiguousServiceException.html">AmbiguousServiceException</a></li>
	</ul>
</div>

<div id="right">
	<form action="http://www.google.com/cse" id="search" onsubmit="if(this.q.value.indexOf('more:')==-1)this.q.value+=' more:api'">
		<input type="hidden" name="cx" value="011549293477758430224:vxofa9ufnhc" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" class="text" /><input type="submit" value="Search" />
	</form>

<div id="navigation">
	<ul>
		<li><a href="overview.html" title="Summary of all namespaces">Overview</a></li>
		<li><a href="namespace-Nette.html" title="Summary of Nette">Namespace</a></li>
		<li class="active">Class</li>
		<li><a href="elements.html">Elements</a></li>
	</ul>
</div>

<div id="content">
	<div id="classSummary">
		<p>namespace <a href="namespace-Nette.html">Nette</a></p>

		<h1>Class Debug</h1>

		<div class="classDescription">
		
<p>Debug static class.</p>

		</div>




		<div class="classInfo">
			<b>Final Class</b><br />
				<b>Author:</b> David Grudl<br />
			<b>Located at</b> <a href="source-Debug.Debug.php.html#19">/Debug/Debug.php</a><br />
		</div>
	</div>


	<div id="methodSummary">
		<table class="summary">
		<caption>Method Summary</caption>
		<tr data-order="1 __construct" id="___construct">
			<td align="right" width="1%"><code class="nowrap">
				final public 
				
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#___construct">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#122" title="go to source code"><b>__construct</b></a>(
			)</code>

			<div class="short">
				
<p>Static class – cannot be instantiated.</p>

			</div>

			<div class="detailed">
				
<p>Static class – cannot be instantiated.</p>






			</div>
			</td>
		</tr>
		<tr data-order="0 dump" id="_dump">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				mixed
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_dump">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#220" title="go to source code"><b>dump</b></a>(
					mixed
					<var>$var</var>, 
					bool
					<var>$return</var> = <span class="php-keyword1">false</span>
			)</code>

			<div class="short">
				
<p>Dumps information about a variable in readable format.</p>

			</div>

			<div class="detailed">
				
<p>Dumps information about a variable in readable format.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$var</code> mixed variable to dump<br />
						<code>$return</code> bool return output instead of printing it? (bypasses $productionMode)<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">mixed variable itself or dump</div>


			</div>
			</td>
		</tr>
		<tr data-order="0 consoleDump" id="_consoleDump">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				mixed
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_consoleDump">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#257" title="go to source code"><b>consoleDump</b></a>(
					mixed
					<var>$var</var>, 
					string
					<var>$title</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Dumps information about a variable in Nette Debug Console.</p>

			</div>

			<div class="detailed">
				
<p>Dumps information about a variable in Nette Debug Console.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$var</code> mixed variable to dump<br />
						<code>$title</code> string optional title<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">mixed variable itself</div>


			</div>
			</td>
		</tr>
		<tr data-order="0 timer" id="_timer">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				elapsed
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_timer">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#393" title="go to source code"><b>timer</b></a>(
					string
					<var>$name</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Starts/stops stopwatch.</p>

			</div>

			<div class="detailed">
				
<p>Starts/stops stopwatch.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$name</code> string name<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">elapsed seconds</div>


			</div>
			</td>
		</tr>
		<tr data-order="0 enable" id="_enable">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_enable">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#413" title="go to source code"><b>enable</b></a>(
					mixed
					<var>$mode</var> = <span class="php-keyword1">NULL</span>, 
					string
					<var>$logFile</var> = <span class="php-keyword1">NULL</span>, 
					array|string
					<var>$email</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Enables displaying or logging errors and exceptions.</p>

			</div>

			<div class="detailed">
				
<p>Enables displaying or logging errors and exceptions.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$mode</code> mixed production, development mode, autodetection or IP address(es).<br />
						<code>$logFile</code> string error log file (FALSE disables logging in production mode)<br />
						<code>$email</code> array|string administrator email or email headers; enables email sending in production mode<br />
					</div>



			</div>
			</td>
		</tr>
		<tr data-order="0 isEnabled" id="_isEnabled">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				bool
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_isEnabled">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#508" title="go to source code"><b>isEnabled</b></a>(
			)</code>

			<div class="short">
				
<p>Is Debug enabled?</p>

			</div>

			<div class="detailed">
				
<p>Is Debug enabled?</p>




					<h4>Returns</h4>
					<div class="smallList">bool </div>


			</div>
			</td>
		</tr>
		<tr data-order="0 processException" id="_processException">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_processException">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#588" title="go to source code"><b>processException</b></a>(
					<a href="Exception.html">Exception</a>
					
					<var>$exception</var>, 
					bool
					<var>$outputAllowed</var> = <span class="php-keyword1">false</span>
			)</code>

			<div class="short">
				
<p>Logs or displays exception.</p>

			</div>

			<div class="detailed">
				
<p>Logs or displays exception.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$exception</code> <a href="Exception.html">Exception</a> <br />
						<code>$outputAllowed</code> bool is writing to standard output buffer allowed?<br />
					</div>



			</div>
			</td>
		</tr>
		<tr data-order="0 toStringException" id="_toStringException">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_toStringException">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#657" title="go to source code"><b>toStringException</b></a>(
					<a href="Exception.html">Exception</a>
					
					<var>$exception</var>
			)</code>

			<div class="short">
				
<p>Handles exception throwed in __toString().</p>

			</div>

			<div class="detailed">
				
<p>Handles exception throwed in __toString().</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$exception</code> <a href="Exception.html">Exception</a> <br />
					</div>



			</div>
			</td>
		</tr>
		<tr data-order="0 enableProfiler" id="_enableProfiler">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_enableProfiler">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#754" title="go to source code"><b>enableProfiler</b></a>(
			)</code>

			<div class="short">
				
<p>Enables profiler.</p>

			</div>

			<div class="detailed">
				
<p>Enables profiler.</p>






			</div>
			</td>
		</tr>
		<tr data-order="0 disableProfiler" id="_disableProfiler">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_disableProfiler">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#765" title="go to source code"><b>disableProfiler</b></a>(
			)</code>

			<div class="short">
				
<p>Disables profiler.</p>

			</div>

			<div class="detailed">
				
<p>Disables profiler.</p>






			</div>
			</td>
		</tr>
		<tr data-order="0 addColophon" id="_addColophon">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				void
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_addColophon">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#780" title="go to source code"><b>addColophon</b></a>(
					callback
					<var>$callback</var>
			)</code>

			<div class="short">
				
<p>Add custom descriptions.</p>

			</div>

			<div class="detailed">
				
<p>Add custom descriptions.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$callback</code> callback <br />
					</div>



			</div>
			</td>
		</tr>
		<tr data-order="0 fireDump" id="_fireDump">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				mixed
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_fireDump">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#853" title="go to source code"><b>fireDump</b></a>(
					mixed
					<var>$var</var>, 
					string
					<var>$key</var>
			)</code>

			<div class="short">
				
<p>Sends variable dump to Firebug tab request/server.</p>

			</div>

			<div class="detailed">
				
<p>Sends variable dump to Firebug tab request/server.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$var</code> mixed variable to dump<br />
						<code>$key</code> string unique key<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">mixed variable itself</div>


			</div>
			</td>
		</tr>
		<tr data-order="0 fireLog" id="_fireLog">
			<td align="right" width="1%"><code class="nowrap">
				 public static
				bool
				
				</code>
			</td>

			<td>
			<a class="anchor" href="#_fireLog">#</a>
			<code class="nowrap">
				<a href="source-Debug.Debug.php.html#867" title="go to source code"><b>fireLog</b></a>(
					mixed
					<var>$message</var>, 
					string
					<var>$priority</var> = <span class="php-quote">'LOG'</span>, 
					string
					<var>$label</var> = <span class="php-keyword1">NULL</span>
			)</code>

			<div class="short">
				
<p>Sends message to Firebug console.</p>

			</div>

			<div class="detailed">
				
<p>Sends message to Firebug console.</p>



					<h4>Parameters</h4>
					<div class="smallList">
						<code>$message</code> mixed message to log<br />
						<code>$priority</code> string priority of message (LOG, INFO, WARN, ERROR, GROUP_START, GROUP_END)<br />
						<code>$label</code> string optional label<br />
					</div>

					<h4>Returns</h4>
					<div class="smallList">bool was successful?</div>


			</div>
			</td>
		</tr>

		</table>
	</div>




	<div id="constantSummary">
		<table class="summary">
		<caption>Constant Summary</caption>
		<tr data-order="DEVELOPMENT" id="DEVELOPMENT">
			<td align="right" width="1%"><code><b>DEVELOPMENT</b></code></td>
			<td><code><span class="php-keyword1">false</span></code> <a href="#DEVELOPMENT" class="anchor">#</a></td>
		</tr>
		<tr data-order="PRODUCTION" id="PRODUCTION">
			<td align="right" width="1%"><code><b>PRODUCTION</b></code></td>
			<td><code><span class="php-keyword1">true</span></code> <a href="#PRODUCTION" class="anchor">#</a></td>
		</tr>
		<tr data-order="DETECT" id="DETECT">
			<td align="right" width="1%"><code><b>DETECT</b></code></td>
			<td><code><span class="php-keyword1">NULL</span></code> <a href="#DETECT" class="anchor">#</a></td>
		</tr>
		<tr data-order="LOG" id="LOG">
			<td align="right" width="1%"><code><b>LOG</b></code></td>
			<td><code><span class="php-quote">'LOG'</span></code> <a href="#LOG" class="anchor">#</a></td>
		</tr>
		<tr data-order="INFO" id="INFO">
			<td align="right" width="1%"><code><b>INFO</b></code></td>
			<td><code><span class="php-quote">'INFO'</span></code> <a href="#INFO" class="anchor">#</a></td>
		</tr>
		<tr data-order="WARN" id="WARN">
			<td align="right" width="1%"><code><b>WARN</b></code></td>
			<td><code><span class="php-quote">'WARN'</span></code> <a href="#WARN" class="anchor">#</a></td>
		</tr>
		<tr data-order="ERROR" id="ERROR">
			<td align="right" width="1%"><code><b>ERROR</b></code></td>
			<td><code><span class="php-quote">'ERROR'</span></code> <a href="#ERROR" class="anchor">#</a></td>
		</tr>
		<tr data-order="TRACE" id="TRACE">
			<td align="right" width="1%"><code><b>TRACE</b></code></td>
			<td><code><span class="php-quote">'TRACE'</span></code> <a href="#TRACE" class="anchor">#</a></td>
		</tr>
		<tr data-order="EXCEPTION" id="EXCEPTION">
			<td align="right" width="1%"><code><b>EXCEPTION</b></code></td>
			<td><code><span class="php-quote">'EXCEPTION'</span></code> <a href="#EXCEPTION" class="anchor">#</a></td>
		</tr>
		<tr data-order="GROUP_START" id="GROUP_START">
			<td align="right" width="1%"><code><b>GROUP_START</b></code></td>
			<td><code><span class="php-quote">'GROUP_START'</span></code> <a href="#GROUP_START" class="anchor">#</a></td>
		</tr>
		<tr data-order="GROUP_END" id="GROUP_END">
			<td align="right" width="1%"><code><b>GROUP_END</b></code></td>
			<td><code><span class="php-quote">'GROUP_END'</span></code> <a href="#GROUP_END" class="anchor">#</a></td>
		</tr>
		</table>
	</div>



	<div id="propertySummary">
		<table class="summary">
		<caption>Property Summary</caption>
		<tr data-order="productionMode" id="$productionMode">
			<td align="right" width="1%"><code class="nowrap">
				 static
				bool
			</code></td>

			<td width="1%"><var>$productionMode</var></td>
			<td><pre><span class="php-keyword1">NULL</span></pre></td>
			<td>determines whether a server is running in production mode <a href="#$productionMode" class="anchor">#</a></td>
		</tr>
		<tr data-order="consoleMode" id="$consoleMode">
			<td align="right" width="1%"><code class="nowrap">
				 static
				bool
			</code></td>

			<td width="1%"><var>$consoleMode</var></td>
			<td><pre><span class="php-keyword1">true</span></pre></td>
			<td>determines whether a server is running in console mode <a href="#$consoleMode" class="anchor">#</a></td>
		</tr>
		<tr data-order="time" id="$time">
			<td align="right" width="1%"><code class="nowrap">
				 static
				int
			</code></td>

			<td width="1%"><var>$time</var></td>
			<td><pre><span class="php-num">1310560836</span>.<span class="php-num">1471</span></pre></td>
			<td> <a href="#$time" class="anchor">#</a></td>
		</tr>
		<tr data-order="maxDepth" id="$maxDepth">
			<td align="right" width="1%"><code class="nowrap">
				 static
				int
			</code></td>

			<td width="1%"><var>$maxDepth</var></td>
			<td><pre><span class="php-num">3</span></pre></td>
			<td>how many nested levels of array/object properties display { <a href="#$maxDepth" class="anchor">#</a></td>
		</tr>
		<tr data-order="maxLen" id="$maxLen">
			<td align="right" width="1%"><code class="nowrap">
				 static
				int
			</code></td>

			<td width="1%"><var>$maxLen</var></td>
			<td><pre><span class="php-num">150</span></pre></td>
			<td>how long strings display { <a href="#$maxLen" class="anchor">#</a></td>
		</tr>
		<tr data-order="showLocation" id="$showLocation">
			<td align="right" width="1%"><code class="nowrap">
				 static
				int
			</code></td>

			<td width="1%"><var>$showLocation</var></td>
			<td><pre><span class="php-keyword1">false</span></pre></td>
			<td>display location? { <a href="#$showLocation" class="anchor">#</a></td>
		</tr>
		<tr data-order="strictMode" id="$strictMode">
			<td align="right" width="1%"><code class="nowrap">
				 static
				bool
			</code></td>

			<td width="1%"><var>$strictMode</var></td>
			<td><pre><span class="php-keyword1">false</span></pre></td>
			<td>determines whether to consider all errors as fatal <a href="#$strictMode" class="anchor">#</a></td>
		</tr>
		<tr data-order="onFatalError" id="$onFatalError">
			<td align="right" width="1%"><code class="nowrap">
				 static
				array
			</code></td>

			<td width="1%"><var>$onFatalError</var></td>
			<td><pre><span class="php-keyword1">array</span> (
)</pre></td>
			<td>of callbacks specifies the functions that are automatically called after
fatal error <a href="#$onFatalError" class="anchor">#</a></td>
		</tr>
		<tr data-order="mailer" id="$mailer">
			<td align="right" width="1%"><code class="nowrap">
				 static
				callback
			</code></td>

			<td width="1%"><var>$mailer</var></td>
			<td><pre><span class="php-keyword1">array</span> (
  <span class="php-num">0</span> =&gt; <span class="php-quote">'Nette\\Debug'</span>,
  <span class="php-num">1</span> =&gt; <span class="php-quote">'defaultMailer'</span>,
)</pre></td>
			<td> <a href="#$mailer" class="anchor">#</a></td>
		</tr>
		<tr data-order="emailSnooze" id="$emailSnooze">
			<td align="right" width="1%"><code class="nowrap">
				 static
				int
			</code></td>

			<td width="1%"><var>$emailSnooze</var></td>
			<td><pre><span class="php-num">172800</span></pre></td>
			<td>interval for sending email is 2 days <a href="#$emailSnooze" class="anchor">#</a></td>
		</tr>
		<tr data-order="counters" id="$counters">
			<td align="right" width="1%"><code class="nowrap">
				 static
				array
			</code></td>

			<td width="1%"><var>$counters</var></td>
			<td><pre><span class="php-keyword1">array</span> (
)</pre></td>
			<td>free counters for your usage <a href="#$counters" class="anchor">#</a></td>
		</tr>

		</table>
	</div>


</div>

	<div id="footer">
		Nette Framework API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</body>
</html>
